/**
 * Copyright (c) 2010 Basil Shikin, BugStat Project
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.bugstat.common.reports;

/**
 * This class defines a value name for a report that has tuples as its results 
 *
 * @author Basil Shikin
 *
 */
public class TupleValueName
    implements ReportValueName
{
    private final String[] names;

    /**
     * Create value name for n-dimensional tuple.
     * 
     * @param n Dimensions of the tuple. Must be positive. 
     */
    public TupleValueName( int n )
    {
        if ( n < 0 ) throw new IllegalArgumentException("Invalid dimentions specified: " + n );
        
        this.names = new String[ n ];
    }
    
    /**
     * Create value name for n-dimensional tuple.
     * 
     * @param names Names of the tuple values. Must be positive. 
     */
    public TupleValueName( String ... names )
    {
        if ( names == null ) throw new IllegalArgumentException("Invalid names specified");
        
        this.names = names;
    }
    
    /**
     * Get name for that value on i-th position of the tuple.
     * 
     * @param i Position of the tuple to get value name at.
     * 
     * @return Value name at i.
     */
    public String getName( int i )
    {
        return names[i];
    }
    
    /**
     * Set value name for i-th position of the tuple.
     * 
     * @param i      Position of the tuple to set name for.
     * @param name  Name to set.
     */
    public void setName( int i, String name )
    {
        names[i] = name;
    }

    
    /**
     * Get number of values in the tuple.
     * 
     * @return Tuple dimension.
     */
    public int getLength()
    {
        return names.length;
    }
}
